Skip to content

[HOLD] AAP-45875 Runtime Feature Flags #736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 12 commits into
base: devel
Choose a base branch
from
Open

[HOLD] AAP-45875 Runtime Feature Flags #736

wants to merge 12 commits into from

Conversation

zkayyali812
Copy link
Contributor

@zkayyali812 zkayyali812 commented Jun 4, 2025 •
edited
Loading

Description

https://issues.redhat.com/browse/AAP-45875

  • What is being changed?
    This change is the foundation for enabling runtime platform feature flags for AAP. This updates the django-ansible-base to be the central location where all platform flags are defined. Components can inherit the ansible_base.feature_flags application to inherit all platform feature flag definitions.
  • Why is this change needed?
    To enable runtime platform feature flags in AAP.
  • How does this change address the issue?
    This change addresses the issue by defining a database flag source, which contains all the feature flags along with their associated metadata.
    These feature flags are installed into each components database at install-time and kept in sync via resource sync (Gateway is the provider)

Before this can be merged, the following should be done -

  1. Confirm each feature flags metadata
    1. Only Dispatcherd and EDA_Analytics feature flags need their metadata confirmed now.

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Documentation update
  • Test update

Self-Review Checklist

  • I have performed a self-review of my code
  • I have added relevant comments to complex code sections
  • I have updated documentation where needed
  • I have considered the security impact of these changes
  • I have considered performance implications
  • I have thought about error handling and edge cases
  • I have tested the changes in my local environment

Testing Instructions

Prerequisites

Steps to Test

Recommend testing this through AAP Dev, but it can be tested directly via the test app as well.

  1. Clone aap-dev
  2. enter aap-dev directory and run make configure-sources
  3. Use this PR for the DAB source
  4. Use this PR for the Gateway source - https://github.com/ansible/aap-gateway/pull/795

Expected Results

AAP Deploys as expected with database feature flags.

Notes

This PR is the prerequisite for the following component PRs -
Gateway - https://github.com/ansible/aap-gateway/pull/795
EDA - ansible/eda-server#1346
Galaxy - ansible/galaxy_ng#2615
AWX - ansible/awx#16030

@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 3 times, most recently from 3822dfe to 6b72afd Compare June 4, 2025 19:31
@zkayyali812 zkayyali812 changed the title WIP: Runtime Feature Flags WIP: AAP-45875 Runtime Feature Flags Jun 4, 2025
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 21 times, most recently from 081fdcc to f492546 Compare June 11, 2025 19:58
This was referenced Jun 11, 2025
Open
Closed
Open
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 2 times, most recently from 3699be8 to 8b6d0bc Compare June 13, 2025 12:21
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 5 times, most recently from fedaa23 to 69f6bbb Compare June 18, 2025 19:58
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 2 times, most recently from 9860248 to 5b7f1f9 Compare June 23, 2025 21:49
@AlanCoding
Copy link
Member

Downstream failures, starting to hit the database for references like this in AWX:

  File "/awx_devel/awx/main/tasks/jobs.py", line 976, in build_env
    if flag_enabled("FEATURE_INDIRECT_NODE_COUNTING_ENABLED"):
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These are probably expected. This is in the job execution path, so that's not too big of a deal.

AlanCoding
AlanCoding reviewed Jun 24, 2025
View reviewed changes
AlanCoding
AlanCoding reviewed Jun 24, 2025
View reviewed changes
AlanCoding
AlanCoding reviewed Jun 24, 2025
View reviewed changes
AlanCoding
AlanCoding reviewed Jun 24, 2025
View reviewed changes
AlanCoding
AlanCoding reviewed Jun 24, 2025
View reviewed changes
AlanCoding
AlanCoding requested changes Jun 24, 2025
View reviewed changes
Copy link
Member

@AlanCoding AlanCoding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good with the decisions made here, totally ready to 👍 this

Almost all my comments are to improve documentation, very simple things.

I'm just unclear if the API endpoints (views, serializers) are finished. I'm confused about that, in terms of what the UI needs to be delivered with this, what the response looks like, and if that's planned for later or anything.

@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch from 5b7f1f9 to dfb2ec7 Compare June 24, 2025 12:19
@zkayyali812
Copy link
Contributor Author

Hey @AlanCoding,

Thanks for the feedback. I just updated to address all of these notes.

Regarding your comments -

  1. The AWX and EDA tests here in DAB should be fixed by their respective PRs -
    1. AWX PR
    2. EDA PR
  2. The API endpoints are finished here. The remainder of the metadata for them is currently intentionally exposed only via gateway, please see Gateway PR

@zkayyali812 zkayyali812 requested a review from AlanCoding June 24, 2025 12:32
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch 2 times, most recently from 37a9a34 to 79da99f Compare June 24, 2025 13:41
@zkayyali812 zkayyali812 force-pushed the phase2/feature-flags/poc branch from 79da99f to 1e9b6aa Compare June 24, 2025 14:00
@github-actions GitHub Actions
Copy link

DVCS PR Check Results:

PR appears valid (JIRA key(s) found)

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@john-westcott-iv john-westcott-iv changed the title AAP-45875 Runtime Feature Flags [HOLD] AAP-45875 Runtime Feature Flags Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlanCoding AlanCoding AlanCoding approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zkayyali812 @AlanCoding